<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>UniMRCP: mrcp_synth_header_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UniMRCP
   &#160;<span id="projectnumber">1.5.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">mrcp_synth_header_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="mrcp__synth__header_8h_source.html">mrcp_synth_header.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae24a0937957af1ceaddd7b6d0f45cb94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrcp__speech__length__value__t.html">mrcp_speech_length_value_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#ae24a0937957af1ceaddd7b6d0f45cb94">jump_size</a></td></tr>
<tr class="separator:ae24a0937957af1ceaddd7b6d0f45cb94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52616b996e7a18c518444db23c8e0631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a52616b996e7a18c518444db23c8e0631">kill_on_barge_in</a></td></tr>
<tr class="separator:a52616b996e7a18c518444db23c8e0631"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54c289ab15161f8bee56569e761758f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a54c289ab15161f8bee56569e761758f4">speaker_profile</a></td></tr>
<tr class="separator:a54c289ab15161f8bee56569e761758f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac074edf6ce9d0c14c9e58df3b6cc2e2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mrcp__synth__header_8h.html#adfc773d2f90a15bb0688c135d51cfb94">mrcp_synth_completion_cause_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#ac074edf6ce9d0c14c9e58df3b6cc2e2f">completion_cause</a></td></tr>
<tr class="separator:ac074edf6ce9d0c14c9e58df3b6cc2e2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebc390a726c1f6f653e3d4fa44a41b92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#aebc390a726c1f6f653e3d4fa44a41b92">completion_reason</a></td></tr>
<tr class="separator:aebc390a726c1f6f653e3d4fa44a41b92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0221900de34bd842f6d5c141da75d51f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrcp__voice__param__t.html">mrcp_voice_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a0221900de34bd842f6d5c141da75d51f">voice_param</a></td></tr>
<tr class="separator:a0221900de34bd842f6d5c141da75d51f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab69c879eb8a794f8c81f028928cf35c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrcp__prosody__param__t.html">mrcp_prosody_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#ab69c879eb8a794f8c81f028928cf35c0">prosody_param</a></td></tr>
<tr class="separator:ab69c879eb8a794f8c81f028928cf35c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07795ae9f2e51a4b37cc73ec8291e299"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a07795ae9f2e51a4b37cc73ec8291e299">speech_marker</a></td></tr>
<tr class="separator:a07795ae9f2e51a4b37cc73ec8291e299"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58c767d6f91a1be81a6a19456ac3c4a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a58c767d6f91a1be81a6a19456ac3c4a6">speech_language</a></td></tr>
<tr class="separator:a58c767d6f91a1be81a6a19456ac3c4a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a620fb77ccc85ea639ec8f685a14cf81d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a620fb77ccc85ea639ec8f685a14cf81d">fetch_hint</a></td></tr>
<tr class="separator:a620fb77ccc85ea639ec8f685a14cf81d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a881c93c8b974a343e77f5bf25199fd50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a881c93c8b974a343e77f5bf25199fd50">audio_fetch_hint</a></td></tr>
<tr class="separator:a881c93c8b974a343e77f5bf25199fd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07e259fc155f07e11fccf175c1801ba4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a07e259fc155f07e11fccf175c1801ba4">failed_uri</a></td></tr>
<tr class="separator:a07e259fc155f07e11fccf175c1801ba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb381bfe51ead61fb66eb751649fb6ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#adb381bfe51ead61fb66eb751649fb6ed">failed_uri_cause</a></td></tr>
<tr class="separator:adb381bfe51ead61fb66eb751649fb6ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c86182c74fa3218ed139c93ff33e2f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a9c86182c74fa3218ed139c93ff33e2f6">speak_restart</a></td></tr>
<tr class="separator:a9c86182c74fa3218ed139c93ff33e2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f4bec5fa2895df57a0313b148970c1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrcp__speech__length__value__t.html">mrcp_speech_length_value_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#a5f4bec5fa2895df57a0313b148970c1a">speak_length</a></td></tr>
<tr class="separator:a5f4bec5fa2895df57a0313b148970c1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0bb0eaf58d3c67148594180ade8e3b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#af0bb0eaf58d3c67148594180ade8e3b8">load_lexicon</a></td></tr>
<tr class="separator:af0bb0eaf58d3c67148594180ade8e3b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8acbbee668f249eddf24076951d55cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapt__str__t.html">apt_str_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__synth__header__t.html#ae8acbbee668f249eddf24076951d55cf">lexicon_search_order</a></td></tr>
<tr class="separator:ae8acbbee668f249eddf24076951d55cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>MRCP synthesizer-header </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a881c93c8b974a343e77f5bf25199fd50"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::audio_fetch_hint</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When the synthesizer needs to fetch documents or other resources like speech audio files, this header controls the corresponding URI access properties </p>

</div>
</div>
<a class="anchor" id="ac074edf6ce9d0c14c9e58df3b6cc2e2f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="mrcp__synth__header_8h.html#adfc773d2f90a15bb0688c135d51cfb94">mrcp_synth_completion_cause_e</a> mrcp_synth_header_t::completion_cause</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MUST be specified in a "SPEAK-COMPLETE" event coming from the synthesizer resource to the client </p>

</div>
</div>
<a class="anchor" id="aebc390a726c1f6f653e3d4fa44a41b92"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::completion_reason</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be specified in a "SPEAK-COMPLETE" event coming from the synthesizer resource to the client </p>

</div>
</div>
<a class="anchor" id="a07e259fc155f07e11fccf175c1801ba4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::failed_uri</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When a synthesizer method needs a synthesizer to fetch or access a URI and the access fails, the server SHOULD provide the failed URI in this header in the method response </p>

</div>
</div>
<a class="anchor" id="adb381bfe51ead61fb66eb751649fb6ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::failed_uri_cause</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When a synthesizer method needs a synthesizer to fetch or access a URI and the access fails the server MUST provide the URI specific or protocol specific response code for the URI in the Failed-URI header in the method response through this header </p>

</div>
</div>
<a class="anchor" id="a620fb77ccc85ea639ec8f685a14cf81d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::fetch_hint</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When the synthesizer needs to fetch documents or other resources like speech markup or audio files, this header controls the corresponding URI access properties </p>

</div>
</div>
<a class="anchor" id="ae24a0937957af1ceaddd7b6d0f45cb94"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrcp__speech__length__value__t.html">mrcp_speech_length_value_t</a> mrcp_synth_header_t::jump_size</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be specified in a CONTROL method and controls the amount to jump forward or backward in an active "SPEAK" request </p>

</div>
</div>
<a class="anchor" id="a52616b996e7a18c518444db23c8e0631"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_synth_header_t::kill_on_barge_in</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be sent as part of the "SPEAK" method to enable kill- on-barge-in support </p>

</div>
</div>
<a class="anchor" id="ae8acbbee668f249eddf24076951d55cf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::lexicon_search_order</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Used to specify a list of active Lexicon URIs and the search order among the active lexicons </p>

</div>
</div>
<a class="anchor" id="af0bb0eaf58d3c67148594180ade8e3b8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_synth_header_t::load_lexicon</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Used to indicate whether a lexicon has to be loaded or unloaded </p>

</div>
</div>
<a class="anchor" id="ab69c879eb8a794f8c81f028928cf35c0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrcp__prosody__param__t.html">mrcp_prosody_param_t</a> mrcp_synth_header_t::prosody_param</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This set of header fields defines the prosody of the speech </p>

</div>
</div>
<a class="anchor" id="a5f4bec5fa2895df57a0313b148970c1a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrcp__speech__length__value__t.html">mrcp_speech_length_value_t</a> mrcp_synth_header_t::speak_length</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be specified in a CONTROL method to control the length of speech to speak, relative to the current speaking point in the currently active "SPEAK" request </p>

</div>
</div>
<a class="anchor" id="a9c86182c74fa3218ed139c93ff33e2f6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> mrcp_synth_header_t::speak_restart</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When a CONTROL request to jump backward is issued to a currently speaking synthesizer resource, and the target jump point is before the start of the current "SPEAK" request, the current "SPEAK" request MUST restart </p>

</div>
</div>
<a class="anchor" id="a54c289ab15161f8bee56569e761758f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::speaker_profile</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MAY be part of the "SET-PARAMS"/"GET-PARAMS" or "SPEAK" request from the client to the server and specifies a URI which references the profile of the speaker </p>

</div>
</div>
<a class="anchor" id="a58c767d6f91a1be81a6a19456ac3c4a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::speech_language</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>specifies the default language of the speech data if the language is not specified in the markup </p>

</div>
</div>
<a class="anchor" id="a07795ae9f2e51a4b37cc73ec8291e299"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structapt__str__t.html">apt_str_t</a> mrcp_synth_header_t::speech_marker</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Contains timestamp information in a "timestamp" field </p>

</div>
</div>
<a class="anchor" id="a0221900de34bd842f6d5c141da75d51f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrcp__voice__param__t.html">mrcp_voice_param_t</a> mrcp_synth_header_t::voice_param</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This set of header fields defines the voice of the speaker </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mrcp__synth__header_8h_source.html">mrcp_synth_header.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2017 10:11:48 for UniMRCP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
